Draft
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds three team-owned style guide harnesses under
docs/style-guides/for the CCIP tooling standardization effort. Each file provides structure, cross-links, scope boundaries (platform vs EVM vs ops), a copyable rule template aligned withdeployment/docs/style-guide-contributions.md, and directional topic lists for teams to fill in—not substantive rules.What changed
docs/style-guides/platform.md— Chain-agnostic changeset practices (shared shapes, refs, datastore, abstractions, etc.).docs/style-guides/evm.md— EVM-specific changeset authoring (selectors, contract surfaces, adapter usage).docs/style-guides/ops.md— Operating and reviewing work via chainlink-deployments (pipelines, environments, run review).Each guide links to the other two, to
deployment/docs/style-guide.md, and todeployment/docs/style-guide-contributions.mdfor the shared maintenance pattern.Why
Reduces implicit knowledge for contributors and reviewers by giving each area a consistent place to capture durable rules over time, without duplicating deployment architecture docs or overlapping concerns across the three guides.